<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
    <title>RaxanDateTime | Raxan User Guide</title>
    <link href="../raxan/styles/master.css" rel="stylesheet" type="text/css" />
    <!--[if IE]><link rel="stylesheet" href="../raxan/styles/master.ie.css" type="text/css"><![endif]-->
    <link href="style.css" rel="stylesheet" type="text/css" />
    <link href="highlight/styles/default.css" rel="stylesheet" type="text/css" />
    <script type="text/javascript" src="highlight/highlight.js"></script>
    <script type="text/javascript">
        hljs.initHighlightingOnLoad('javascript','html','php');
    </script>

</head>

<body>
    <div class="container c48 prepend-top">
        <h2 class="bottom">Raxan User Guide</h2>
        <div class="navbar">
            <div class="lf"><div class="rt"><div class="md">
                <ul>
                    <li><a href="../index.html" title="The Rich Ajax, CSS &amp; PHP Framework" >Home</a></li>
                    <li><a href="table-of-contents.html" title="Blog Posts" >Table Of Contents</a></li>
                    <li><a href="../php-examples/index.php" title="PHP Examples" >PHP Examples</a></li>
                    <li><a href="../css-examples/index.html" title="User Guide" >CSS Examples</a></li>
                </ul>
            </div></div></div>
        </div>
        <div class="prepend1 append1">
            <div class="ltm" align="right">
                <a href="table-of-contents.html" title="Show Table of Content">
                    <img src="images/toc-button.png"  alt="Table of Contents" />
                </a>
            </div>
            <div class="container c45">

    <h2 class="class-name">Class RaxanDateTime</h2>

    <a name="sec-description"></a>
    <div class="box bmm">
        <div class="box-title">Description</div>
        <div class="nav-bar">
            <span class="disabled">Description</span> |
            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
            |                                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

        </div>
        <div class="box bmm-body">
            <!-- ========== Info from phpDoc block ========= -->
            <p class="short-description">RaxanDateTime Class for handling dates beyond the 1970 and 2038   Requires ADODB_Date library file to be in the same path as this library   Written by Raymond Irving 2008</p>
            <p class="description"><p>This Class Library is distributed under the terms of the GNU GPL and MIT license with   the exception of the ADOdb Date Library which is distributed under it's respective license(s).   See the adodb-time.inc.php file for furthor information.</p></p>
            <p class="notes">
                Located in <a class="field" href="#">raxan/pdi/shared/raxan.datetime.php</a> (line <span class="field">13</span>)
            </p>


            <pre></pre>

        </div>
    </div>



    <a name="sec-var-summary"></a>
    <div class="box bmm">
        <div class="box-title">Variable Summary</span></div>
        <div class="nav-bar">
            <a href="#sec-description">Description</a> |
            <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
            |
            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

        </div>
        <div class="box bmm-body">
            <div class="var-summary">
                <div class="var-title">
                    static <span class="var-type">mixed</span>
                    <a href="#$months" title="details" class="var-name">$months</a>
                </div>
                <div class="var-title">
                    <span class="var-type">mixed</span>
                    <a href="#$_timestamp" title="details" class="var-name">$_timestamp</a>
                </div>
            </div>
        </div>
    </div>

    <a name="sec-method-summary"></a>
    <div class="box bmm">
        <div class="box-title">Method Summary</span></div>
        <div class="nav-bar">
            <a href="#sec-description">Description</a> |
            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)

            |
            <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
        </div>
        <div class="box bmm-body">
            <div class="method-summary">

                <div class="method-definition">
                    <span class="method-result">RaxanDateTime</span>
                    <a href="#__construct" title="details" class="method-name">__construct</a>
                    ([<span class="var-type">$str</span>&nbsp;<span class="var-name">$str</span> = <span class="var-default">''</span>])
                </div>
                <div class="method-definition">
                    <span class="method-result">String</span>
                    <a href="#format" title="details" class="method-name">format</a>
                    (<span class="var-type">$fmt</span>&nbsp;<span class="var-name">$fmt</span>, [<span class="var-type">$dtTime</span>&nbsp;<span class="var-name">$dtTime</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$noTrans</span> = <span class="var-default">false</span>])
                </div>
                <div class="method-definition">
                    <span class="method-result">int</span>
                    <a href="#getTimestamp" title="details" class="method-name">getTimestamp</a>
                    ([<span class="var-type"></span>&nbsp;<span class="var-name">$date</span> = <span class="var-default">''</span>])
                </div>
                <div class="method-definition">
                    <span class="method-result">Array</span>
                    <a href="#parse" title="details" class="method-name">parse</a>
                    (<span class="var-type">$str</span>&nbsp;<span class="var-name">$str</span>)
                </div>
                <div class="method-definition">
                    <span class="method-result">void</span>
                    <a href="#setDate" title="details" class="method-name">setDate</a>
                    (<span class="var-type">$str</span>&nbsp;<span class="var-name">$str</span>)
                </div>
                <div class="method-definition">
                    <span class="method-result">void</span>
                    <a href="#_makeTimestamp" title="details" class="method-name">_makeTimestamp</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$str</span>)
                </div>
                <div class="method-definition">
                    <span class="method-result">void</span>
                    <a href="#__toString" title="details" class="method-name">__toString</a>
                    ()
                </div>
            </div>
        </div>
    </div>

    <a name="sec-vars"></a>
    <div class="box bmm">
        <div class="box-title">Variables</div>
        <div class="nav-bar">
            <a href="#sec-description">Description</a> |
            <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)


            |
            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

        </div>
        <div class="box bmm-body">
            <a name="var$months" id="$months"><!-- --></a>
            <div class="evenrow">

                <div class="var-header">
                    <span class="var-title">
                        static <span class="var-type">mixed</span>
                        <span class="var-name">$months</span>
                        (line <span class="line-number">18</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>





            </div>
            <a name="var$_timestamp" id="$_timestamp"><!-- --></a>
            <div class="oddrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">mixed</span>
                        <span class="var-name">$_timestamp</span>
                        = <span class="var-default"> null</span>            (line <span class="line-number">15</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>





            </div>

        </div>
    </div>

    <a name="sec-methods"></a>
    <div class="box bmm">
        <div class="box-title">Methods</div>
        <div class="nav-bar">
            <a href="#sec-description">Description</a> |
            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
            <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)

        </div>
        <div class="box bmm-body">
            <a name='method_detail'></a>
            <a name="method__construct" id="__construct"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">Constructor __construct</span> (line <span class="line-number">26</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Date Class Constructor</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">RaxanDateTime</span>
                    <span class="method-name">
                        __construct
                    </span>
                    ([<span class="var-type">$str</span>&nbsp;<span class="var-name">$str</span> = <span class="var-default">''</span>])
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type">$str</span>
                        <span class="var-name">$str</span><span class="var-description">: (Optional) String containing a valid date in the formats:  Date: dd mmm yyyy,<br />mmm dd yyyy,<br /> mm/dd/yyy,<br /> yyyy/mm/dd,<br /> dd/mm/yyyy.  Also supports the delimitors &quot;.&quot; and &quot;-&quot;. Example: mm-dd-yyyy or mm.dd.yyyy  Time: hh:mm:ss - Supports the time format that is supported by PHP</span>            </li>
                </ul>


            </div>
            <a name="methodformat" id="format"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">format</span> (line <span class="line-number">76</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Format and returns a date string. This function used the PHP date() format.</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">String</span>
                    <span class="method-name">
                        format
                    </span>
                    (<span class="var-type">$fmt</span>&nbsp;<span class="var-name">$fmt</span>, [<span class="var-type">$dtTime</span>&nbsp;<span class="var-name">$dtTime</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$noTrans</span> = <span class="var-default">false</span>])
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type">$fmt</span>
                        <span class="var-name">$fmt</span><span class="var-description">: String</span>            </li>
                    <li>
                        <span class="var-type">$dtTime</span>
                        <span class="var-name">$dtTime</span><span class="var-description">: Mixed [optional] DateTime String or ADODB Date TimeStamp</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$noTrans</span>            </li>
                </ul>


            </div>
            <a name="methodgetTimestamp" id="getTimestamp"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">getTimestamp</span> (line <span class="line-number">65</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns an ADODB Date timestamp</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">int</span>
                    <span class="method-name">
                        getTimestamp
                    </span>
                    ([<span class="var-type"></span>&nbsp;<span class="var-name">$date</span> = <span class="var-default">''</span>])
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$date</span>            </li>
                </ul>


            </div>
            <a name="methodparse" id="parse"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">parse</span> (line <span class="line-number">97</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Parses a date string and returns an array containing the date parts otherwise false  It's works great with date values returned from MSSQL, MySQL and others.</p>
                <ul class="tags">
                    <li><span class="field">return:</span> Returns an array that contains the date parts: year, month, mday, minutes,hours and seconds</li>
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">Array</span>
                    <span class="method-name">
                        parse
                    </span>
                    (<span class="var-type">$str</span>&nbsp;<span class="var-name">$str</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type">$str</span>
                        <span class="var-name">$str</span><span class="var-description">: String Supported Date/Time string format</span>            </li>
                </ul>


            </div>
            <a name="methodsetDate" id="setDate"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">setDate</span> (line <span class="line-number">44</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Sets the Date/Time for the Date object</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">void</span>
                    <span class="method-name">
                        setDate
                    </span>
                    (<span class="var-type">$str</span>&nbsp;<span class="var-name">$str</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type">$str</span>
                        <span class="var-name">$str</span><span class="var-description">: String containing a valid date</span>            </li>
                </ul>


            </div>
            <a name="method_makeTimestamp" id="_makeTimestamp"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">_makeTimestamp</span> (line <span class="line-number">52</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> protected</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">void</span>
                    <span class="method-name">
                        _makeTimestamp
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$str</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$str</span>            </li>
                </ul>


            </div>
            <a name="method__toString" id="__toString"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">__toString</span> (line <span class="line-number">171</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">void</span>
                    <span class="method-name">
                        __toString
                    </span>
                    ()
                </div>



            </div>

        </div>
    </div>

</div>

        </div>
        <div class="tpb pad" style="text-align:right">
            <div class="right ltm">
                <a href="table-of-contents.html" title="Back to Table of Content">
                    <img src="images/toc-button.png"  alt="Table of Contents" />
                </a>
            </div>
        </div>
    </div>
</body>

</html>

